Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3 R2

E.?? StructureDefinition: ehrsrle-auditevent

Electronic Health Records Work Group Maturity Level: 1Trial Use Use Context: Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent

Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard

This profile was published on Thu, Dec 4, 2014 00:00+1100 as a draft by Health Level Seven International (Electronic Health Record).

E.??.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from AuditEvent.

Summary

Must-Support: 25 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent I0..*AuditEventRecord of an event
... id Σ0..1idLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... type SΣI1..1CodingType/identifier of event
Binding: Audit Event ID (extensible)
... subtype SΣI0..*CodingMore specific type/id for the event
Binding: Audit Event Sub-Type (extensible)
... action SΣI0..1codeType of action performed during the event
Binding: AuditEventAction (required)
... severity ΣI0..1codeEmergency | Alert | Critical | Error | Warning | Notice | Informational | Debug
Binding: AuditEventSeverity (required)
... period I0..1PeriodWhen the activity occurred
... recorded SΣI1..1instantTime when the event was recorded
... outcome ΣI0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required)
... outcomeDesc ΣI0..1stringDescription of the event outcome
... purposeOfEvent SΣI0..*CodeableConceptThe purposeOfUse of the event
Binding: PurposeOfUse (extensible)
... agent SI1..*BackboneElementActor involved in the event
.... id 0..1idUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type I0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible)
.... role SI0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example)
.... who SΣI0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
.... altId I0..1stringAlternative User identity
.... name I0..1stringHuman friendly name for the agent
.... requestor SΣI1..1booleanWhether user is initiator
.... location SI0..1Reference(Location)Where
.... policy SI0..*uriPolicy that authorized event
.... media I0..1CodingType of media
Binding: Media Type Code (extensible)
.... network SI0..1BackboneElementLogical network location for application activity
..... id 0..1idUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... address SI0..1stringIdentifier for the network access point of the user device
..... type SI0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required)
.... purposeOfUse SI0..*CodeableConceptReason given for this user
Binding: PurposeOfUse (extensible)
... source SI1..1BackboneElementAudit Event Reporter
.... id 0..1idUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site SI0..1stringLogical source location within the enterprise
.... observer SΣI1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
.... type SI0..*CodingThe type of source where event originated
Binding: Audit Event Source Type (extensible)
... entity SI0..*BackboneElementData or objects used
.... id 0..1idUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... what SΣI0..1Reference(Resource)Specific instance of resource
.... type SI0..1CodingType of entity involved
Binding: Audit event entity type (extensible)
.... role SI0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible)
.... lifecycle SI0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible)
.... securityLabel SI0..*CodingSecurity labels on the entity
Binding: SecurityLabels (extensible)
.... name ΣI0..1stringDescriptor for entity
.... query ΣI0..1base64BinaryQuery parameters
.... detail I0..*BackboneElementAdditional Information about the entity
..... id 0..1idUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type I1..1stringName of the property
..... value[x] I1..1Property value
...... valueStringstring
...... valueBase64Binarybase64Binary

doco Documentation for this format
<!-- EHRS FM Record Lifecycle Event - Audit Event -->doco

<AuditEvent xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <type><!-- ?? 1..1 Coding Type/identifier of event   --></type>
 <subtype><!-- ?? 0..* Coding More specific type/id for the event   --></subtype>
 <action value="[code]"/><!-- ?? 0..1 Type of action performed during the event   -->
 <severity value="[code]"/><!-- ?? 0..1 Emergency | Alert | Critical | Error | Warning | Notice | Informational | Debug   -->
 <period><!-- ?? 0..1 Period When the activity occurred --></period>
 <recorded value="[instant]"/><!-- ?? 1..1 Time when the event was recorded -->
 <outcome value="[code]"/><!-- ?? 0..1 Whether the event succeeded or failed   -->
 <outcomeDesc value="[string]"/><!-- ?? 0..1 Description of the event outcome -->
 <purposeOfEvent><!-- ?? 0..* CodeableConcept The purposeOfUse of the event   --></purposeOfEvent>
 <agent> ?? 1..* BackboneElement  <!-- ?? 1..* Actor involved in the event -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- ?? 0..1 CodeableConcept How agent participated   --></type>
  <role><!-- ?? 0..* CodeableConcept Agent role in the event   --></role>
  <who><!-- ?? 0..1 Reference(PractitionerRole) Identifier of who --></who>
  <altId value="[string]"/><!-- ?? 0..1 Alternative User identity -->
  <name value="[string]"/><!-- ?? 0..1 Human friendly name for the agent -->
  <requestor value="[boolean]"/><!-- ?? 1..1 Whether user is initiator -->
  <location><!-- ?? 0..1 Reference(Location) Where --></location>
  <policy value="[uri]"/><!-- ?? 0..* Policy that authorized event -->
  <media><!-- ?? 0..1 Coding Type of media   --></media>
  <network> ?? 0..1 BackboneElement  <!-- ?? 0..1 Logical network location for application activity -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <address value="[string]"/><!-- ?? 0..1 Identifier for the network access point of the user device -->
   <type value="[code]"/><!-- ?? 0..1 The type of network access point   -->
  </network>
  <purposeOfUse><!-- ?? 0..* CodeableConcept Reason given for this user   --></purposeOfUse>
 </agent>
 <source> ?? 1..1 BackboneElement  <!-- ?? 1..1 Audit Event Reporter -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <site value="[string]"/><!-- ?? 0..1 Logical source location within the enterprise -->
  <observer><!-- ?? 1..1 Reference(PractitionerRole) 
      The identity of source detecting the event --></observer>
  <type><!-- ?? 0..* Coding The type of source where event originated   --></type>
 </source>
 <entity> ?? 0..* BackboneElement  <!-- ?? 0..* Data or objects used -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <what><!-- ?? 0..1 Reference(Resource) Specific instance of resource --></what>
  <type><!-- ?? 0..1 Coding Type of entity involved   --></type>
  <role><!-- ?? 0..1 Coding What role the entity played   --></role>
  <lifecycle><!-- ?? 0..1 Coding Life-cycle stage for the entity    --></lifecycle>
  <securityLabel><!-- ?? 0..* Coding Security labels on the entity   --></securityLabel>
  <name value="[string]"/><!-- ?? 0..1 Descriptor for entity -->
  <query value="[base64Binary]"/><!-- ?? 0..1 Query parameters -->
  <detail> ?? 0..* BackboneElement  <!-- ?? 0..* Additional Information about the entity -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[string]"/><!-- ?? 1..1 Name of the property -->
   <value[x]><!-- ?? 1..1 string|base64Binary 
       Property value --></value[x]>
  </detail>
 </entity>
</AuditEvent>

{ // EHRS FM Record Lifecycle Event - Audit Event
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "type" : { Coding }, // C? R! Type/identifier of event
    "subtype" : [{ Coding }], // C?More specific type/id for the event
    "action" : "<code>", // C?Type of action performed during the event
    "severity" : "<code>", // C?Emergency | Alert | Critical | Error | Warning | Notice | Informational | Debug
    "period" : { Period }, // C?When the activity occurred
    "recorded" : "<instant>", // C? R! Time when the event was recorded
    "outcome" : "<code>", // C?Whether the event succeeded or failed
    "outcomeDesc" : "<string>", // C?Description of the event outcome
    "purposeOfEvent" : [{ CodeableConcept }], // C?The purposeOfUse of the event
    "agent" : [{ BackboneElement }], // C? R! Actor involved in the event
    "source" : { BackboneElement }, // C? R! Audit Event Reporter
    "entity" : [{ BackboneElement }] // C?Data or objects used
  }

This structure is derived from AuditEvent.

Summary

Must-Support: 25 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent I0..*AuditEventRecord of an event
... id Σ0..1idLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... type SΣI1..1CodingType/identifier of event
Binding: Audit Event ID (extensible)
... subtype SΣI0..*CodingMore specific type/id for the event
Binding: Audit Event Sub-Type (extensible)
... action SΣI0..1codeType of action performed during the event
Binding: AuditEventAction (required)
... severity ΣI0..1codeEmergency | Alert | Critical | Error | Warning | Notice | Informational | Debug
Binding: AuditEventSeverity (required)
... period I0..1PeriodWhen the activity occurred
... recorded SΣI1..1instantTime when the event was recorded
... outcome ΣI0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required)
... outcomeDesc ΣI0..1stringDescription of the event outcome
... purposeOfEvent SΣI0..*CodeableConceptThe purposeOfUse of the event
Binding: PurposeOfUse (extensible)
... agent SI1..*BackboneElementActor involved in the event
.... id 0..1idUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type I0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible)
.... role SI0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example)
.... who SΣI0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
.... altId I0..1stringAlternative User identity
.... name I0..1stringHuman friendly name for the agent
.... requestor SΣI1..1booleanWhether user is initiator
.... location SI0..1Reference(Location)Where
.... policy SI0..*uriPolicy that authorized event
.... media I0..1CodingType of media
Binding: Media Type Code (extensible)
.... network SI0..1BackboneElementLogical network location for application activity
..... id 0..1idUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... address SI0..1stringIdentifier for the network access point of the user device
..... type SI0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required)
.... purposeOfUse SI0..*CodeableConceptReason given for this user
Binding: PurposeOfUse (extensible)
... source SI1..1BackboneElementAudit Event Reporter
.... id 0..1idUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site SI0..1stringLogical source location within the enterprise
.... observer SΣI1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
.... type SI0..*CodingThe type of source where event originated
Binding: Audit Event Source Type (extensible)
... entity SI0..*BackboneElementData or objects used
.... id 0..1idUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... what SΣI0..1Reference(Resource)Specific instance of resource
.... type SI0..1CodingType of entity involved
Binding: Audit event entity type (extensible)
.... role SI0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible)
.... lifecycle SI0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible)
.... securityLabel SI0..*CodingSecurity labels on the entity
Binding: SecurityLabels (extensible)
.... name ΣI0..1stringDescriptor for entity
.... query ΣI0..1base64BinaryQuery parameters
.... detail I0..*BackboneElementAdditional Information about the entity
..... id 0..1idUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type I1..1stringName of the property
..... value[x] I1..1Property value
...... valueStringstring
...... valueBase64Binarybase64Binary

doco Documentation for this format

XML Template

<!-- EHRS FM Record Lifecycle Event - Audit Event -->doco

<AuditEvent xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <type><!-- ?? 1..1 Coding Type/identifier of event   --></type>
 <subtype><!-- ?? 0..* Coding More specific type/id for the event   --></subtype>
 <action value="[code]"/><!-- ?? 0..1 Type of action performed during the event   -->
 <severity value="[code]"/><!-- ?? 0..1 Emergency | Alert | Critical | Error | Warning | Notice | Informational | Debug   -->
 <period><!-- ?? 0..1 Period When the activity occurred --></period>
 <recorded value="[instant]"/><!-- ?? 1..1 Time when the event was recorded -->
 <outcome value="[code]"/><!-- ?? 0..1 Whether the event succeeded or failed   -->
 <outcomeDesc value="[string]"/><!-- ?? 0..1 Description of the event outcome -->
 <purposeOfEvent><!-- ?? 0..* CodeableConcept The purposeOfUse of the event   --></purposeOfEvent>
 <agent> ?? 1..* BackboneElement  <!-- ?? 1..* Actor involved in the event -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- ?? 0..1 CodeableConcept How agent participated   --></type>
  <role><!-- ?? 0..* CodeableConcept Agent role in the event   --></role>
  <who><!-- ?? 0..1 Reference(PractitionerRole) Identifier of who --></who>
  <altId value="[string]"/><!-- ?? 0..1 Alternative User identity -->
  <name value="[string]"/><!-- ?? 0..1 Human friendly name for the agent -->
  <requestor value="[boolean]"/><!-- ?? 1..1 Whether user is initiator -->
  <location><!-- ?? 0..1 Reference(Location) Where --></location>
  <policy value="[uri]"/><!-- ?? 0..* Policy that authorized event -->
  <media><!-- ?? 0..1 Coding Type of media   --></media>
  <network> ?? 0..1 BackboneElement  <!-- ?? 0..1 Logical network location for application activity -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <address value="[string]"/><!-- ?? 0..1 Identifier for the network access point of the user device -->
   <type value="[code]"/><!-- ?? 0..1 The type of network access point   -->
  </network>
  <purposeOfUse><!-- ?? 0..* CodeableConcept Reason given for this user   --></purposeOfUse>
 </agent>
 <source> ?? 1..1 BackboneElement  <!-- ?? 1..1 Audit Event Reporter -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <site value="[string]"/><!-- ?? 0..1 Logical source location within the enterprise -->
  <observer><!-- ?? 1..1 Reference(PractitionerRole) 
      The identity of source detecting the event --></observer>
  <type><!-- ?? 0..* Coding The type of source where event originated   --></type>
 </source>
 <entity> ?? 0..* BackboneElement  <!-- ?? 0..* Data or objects used -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <what><!-- ?? 0..1 Reference(Resource) Specific instance of resource --></what>
  <type><!-- ?? 0..1 Coding Type of entity involved   --></type>
  <role><!-- ?? 0..1 Coding What role the entity played   --></role>
  <lifecycle><!-- ?? 0..1 Coding Life-cycle stage for the entity    --></lifecycle>
  <securityLabel><!-- ?? 0..* Coding Security labels on the entity   --></securityLabel>
  <name value="[string]"/><!-- ?? 0..1 Descriptor for entity -->
  <query value="[base64Binary]"/><!-- ?? 0..1 Query parameters -->
  <detail> ?? 0..* BackboneElement  <!-- ?? 0..* Additional Information about the entity -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[string]"/><!-- ?? 1..1 Name of the property -->
   <value[x]><!-- ?? 1..1 string|base64Binary 
       Property value --></value[x]>
  </detail>
 </entity>
</AuditEvent>

JSON Template

{ // EHRS FM Record Lifecycle Event - Audit Event
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "type" : { Coding }, // C? R! Type/identifier of event
    "subtype" : [{ Coding }], // C?More specific type/id for the event
    "action" : "<code>", // C?Type of action performed during the event
    "severity" : "<code>", // C?Emergency | Alert | Critical | Error | Warning | Notice | Informational | Debug
    "period" : { Period }, // C?When the activity occurred
    "recorded" : "<instant>", // C? R! Time when the event was recorded
    "outcome" : "<code>", // C?Whether the event succeeded or failed
    "outcomeDesc" : "<string>", // C?Description of the event outcome
    "purposeOfEvent" : [{ CodeableConcept }], // C?The purposeOfUse of the event
    "agent" : [{ BackboneElement }], // C? R! Actor involved in the event
    "source" : { BackboneElement }, // C? R! Audit Event Reporter
    "entity" : [{ BackboneElement }] // C?Data or objects used
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

E.??.2 Terminology Bindings

PathNameConformanceValueSet
AuditEvent.languageCommon LanguagespreferredCommon Languages
AuditEvent.typeAudit Event IDextensibleAudit Event ID
AuditEvent.subtypeAudit Event Sub-TypeextensibleAudit Event Sub-Type
AuditEvent.actionAuditEventActionrequiredAuditEventAction
AuditEvent.severityAuditEventSeverityrequiredAuditEventSeverity
AuditEvent.outcomeAuditEventOutcomerequiredAuditEventOutcome
AuditEvent.purposeOfEventV3 Value SetPurposeOfUseextensibleV3 Value SetPurposeOfUse
AuditEvent.agent.typeParticipationRoleTypeextensibleParticipationRoleType
AuditEvent.agent.roleSecurityRoleTypeexampleSecurityRoleType
AuditEvent.agent.mediaMedia Type CodeextensibleMedia Type Code
AuditEvent.agent.network.typeAuditEventAgentNetworkTyperequiredAuditEventAgentNetworkType
AuditEvent.agent.purposeOfUseV3 Value SetPurposeOfUseextensibleV3 Value SetPurposeOfUse
AuditEvent.source.typeAudit Event Source TypeextensibleAudit Event Source Type
AuditEvent.entity.typeAudit event entity typeextensibleAudit event entity type
AuditEvent.entity.roleAuditEventEntityRoleextensibleAuditEventEntityRole
AuditEvent.entity.lifecycle?extextensibleobject-lifecycle-events
AuditEvent.entity.securityLabelSecurityLabelsextensibleSecurityLabels
.